Developper des plugins pour BankPerfect

Théorie

BankPerfect est désormais modulaire : il vous permet de créer vos propres fonctions qui seront appelées de façon transparente telles des fonctionnalités intégrées au logiciel.

Pour ce faire, il vous suffit de :

  1. Créer une dll depuis n'importe quel langage exportant la fonction Execute(BP : IDispatch)
  2. D'accompagner cette dll d'un fichier plugin.ini qui sera situé dans le même dossier que la dll et qui va servir à décrire comment BankPerfect doit intégrer cette dll.


Pratique


Fichiers nécessaires

Pour créer un plugin, il faut tout d'abord télécharger le plugin le plus basique Simple qui contient un modèle type de plugin déjà développé avec ses sources sous Delphi.

Vous pouvez également télécharger le plugin plus complet Test qui donne une idée plus précises des différentes fonctions disponibles dans l'interface.

Téléchargez et installez le kit de déploiement afin de pouvoir créer, à partir des fichiers qui composent le plugin, un seul fichier setup.exe qui s'installera automatiquement dans BankPerfect (Cf. section déploiement)

Il faut aussi que BankPerfect (version 4.5 ou supérieures) soit installé sur votre poste afin que vous puissiez tester votre plugin.

Le fichier plugin.ini

Le fichier plugin.ini doit contenir les clés suivantes dans son unique section [BANKPERFECT_SCRIPT] :

name=<Nom Du Plugin> (ligne obligatoire)
cette clé permet de donner un nom au plugin
path=Item1>Item2 (ligne optionnelle)
cette clé permet de placer le plugin dans les menus de BankPerfect. Si cette clé est omise, le plugin apparaîtra directement dans le menu Plugins de BankPerfect. Sinon, il apparaître dans l'arborescence indiquée (dans cet exemple, le plugin sera situé dans le sous-menu Item2 du sous-menu Item1 du menu Plugins de BankPerfect)
ReadOnly=1 (ligne optionnelle)
cette clé permet d'indiquer à bankPerfect si ce plugin va modifier les données du fichier ouvert (ReadOnly=0) ou non (ReadOnly=1)


Facultatif: Pour une meilleure prise en charge par le plugin Scripts Manager, vous pouvez ajouter une ligne

version=X.n (ligne optionnelle)
cette clé permet au plugin 'Scripts Manager' d'indiquer la version de votre plugin


L'interface avec BankPerfect

Pour développer votre DLL, vous avez accès à toutes les fonctions décrites dans la section 3 grâce au paramètre BP (de type IDispatch) de la fonction exportée Execute.

L'interface IDispatch est en fait une interface vers un objet IBankPerfectPlugin qui intègre toutes les fonctions vous permettant d'accéder aux données des fichiers BankPerfect et de piloter l'application tel que vous le souhaitez.

Si vous développez votre plugin sous Delphi, l'interface est disponible en ouvrant directement depuis Delphi le fichier bankPerfect.exe.


Déploiement du plugin

Pour faire fonctionner votre plugin, il doit être placé avec son fichier plugin.ini de la façon suivante :

  1. S'il n'existe pas déjà, créez un dossier Plugins dans le dossier où se trouve l'applicatif bankperfect.exe
  2. Créez dans ce dossier Plugins un dossier au nom de votre plugin
  3. Placez dans ce dernier dossier votre dll, le fichier plugin.ini et tous les autres fichiers nécessaires au bon fonctionnement de votre dll

Cette procédure manuelle peut être automatisée : le kit de déploiement vous permet de créer en 2 clics de souris un fichier auto-extractible compressé qui installera votre plugin dans BankPerfect.

  1. Groupez dans un dossier du nom de votre plugin tous les fichiers nécessaires au fonctionnement du plugin
  2. Lancez le kit de déploiement et sélectionnez le dossier où se trouvent vos fichiers groupés
  3. Cliquez sur le bouton Créer le setup
  4. Choisissez le dossier ou votre setup.exe sera stocké
  5. Allez à l'adresse https://www.chelly.net/?page=bp_plugins pour y référencer votre plugin